<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>bn::best_fit_allocator class | Butano Docs</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <link rel="icon" href="favicon-dark.png" type="image/png" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <meta name="theme-color" content="#22272e" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
        <a href="https://github.com/GValiente/butano">Butano</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</a>
      </span>
      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
        <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
          <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
        </svg></a>
        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
      </div>
      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
        <div class="m-row">
          <ol class="m-col-t-6 m-col-m-none">
            <li><a href="pages.html">Pages</a></li>
            <li><a href="modules.html">Modules</a></li>
          </ol>
          <ol class="m-col-t-6 m-col-m-none" start="3">
            <li><a href="namespaces.html">Namespaces</a></li>
            <li><a href="annotated.html">Classes</a></li>
            <li><a href="files.html">Files</a></li>
            <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
              <use href="#m-doc-search-icon-path" />
            </svg></a></li>
          </ol>
        </div>
      </div>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          <span class="m-breadcrumb"><a href="namespacebn.html">bn</a>::<wbr/></span>best_fit_allocator <span class="m-thin">class</span>
          <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__best__fit__allocator_8h.html">&lt;bn_best_fit_allocator.h&gt;</a></div>
        </h1>
        <p>Manages a chunk of memory with a best fit allocation strategy.</p>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#pub-types">Public types</a></li>
                <li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
                <li><a href="#pub-methods">Public functions</a></li>
              </ul>
            </li>
          </ul>
        </nav>
        <section id="pub-types">
          <h2><a href="#pub-types">Public types</a></h2>
          <dl class="m-doc">
            <dt id="a809c23e52711015a49b2f16057769250">
              using <a href="#a809c23e52711015a49b2f16057769250" class="m-doc-self">size_type</a> = int
            </dt>
            <dd>Size type alias.</dd>
          </dl>
        </section>
        <section id="typeless-methods">
          <h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
          <dl class="m-doc">
            <dt id="ac1584f648b774c2a66b6e4e8e0784897">
              <span class="m-doc-wrap-bumper"><a href="#ac1584f648b774c2a66b6e4e8e0784897" class="m-doc-self">best_fit_allocator</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-info">defaulted</span></span>
            </dt>
            <dd>Default constructor.</dd>
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#ace6e7ccb38e57c0780e58727a28f1e8c" class="m-doc">best_fit_allocator</a>(</span><span class="m-doc-wrap">void* start,
              <a href="#a809c23e52711015a49b2f16057769250" class="m-doc">size_<wbr />type</a> bytes)</span>
            </dt>
            <dd>Constructor.</dd>
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#ab4e580faa25922fa10e1f1bebcbf9d51" class="m-doc">~best_fit_allocator</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-success">noexcept</span></span>
            </dt>
            <dd>Destructor.</dd>
          </dl>
        </section>
        <section id="pub-methods">
          <h2><a href="#pub-methods">Public functions</a></h2>
          <dl class="m-doc">
            <dt id="a3dac825d7c309112331189c221c23fe6">
              <span class="m-doc-wrap-bumper">auto <a href="#a3dac825d7c309112331189c221c23fe6" class="m-doc-self">used_bytes</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="#a809c23e52711015a49b2f16057769250" class="m-doc">size_<wbr />type</a></span>
            </dt>
            <dd>Returns the size in bytes of all allocated items.</dd>
            <dt id="a7ab0d4d08b290d154b0d9d51a9bea96d">
              <span class="m-doc-wrap-bumper">auto <a href="#a7ab0d4d08b290d154b0d9d51a9bea96d" class="m-doc-self">available_bytes</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="#a809c23e52711015a49b2f16057769250" class="m-doc">size_<wbr />type</a></span>
            </dt>
            <dd>Returns the number of bytes that still can be allocated.</dd>
            <dt id="a07918cf99c8e49656185513affed65fe">
              <span class="m-doc-wrap-bumper">auto <a href="#a07918cf99c8e49656185513affed65fe" class="m-doc-self">empty</a>(</span><span class="m-doc-wrap">) const -&gt; bool</span>
            </dt>
            <dd>Indicates if it doesn&#x27;t contain any item.</dd>
            <dt id="ae3c42539ffbd2b942168e306b5de2e53">
              <span class="m-doc-wrap-bumper">auto <a href="#ae3c42539ffbd2b942168e306b5de2e53" class="m-doc-self">full</a>(</span><span class="m-doc-wrap">) const -&gt; bool</span>
            </dt>
            <dd>Indicates if it can&#x27;t contain any more items.</dd>
            <dt id="a928949d8be455d94c951d50888ccacc0">
              <span class="m-doc-wrap-bumper">auto <a href="#a928949d8be455d94c951d50888ccacc0" class="m-doc-self">check_empty_on_destructor</a>(</span><span class="m-doc-wrap">) const -&gt; bool</span>
            </dt>
            <dd>Indicates if the allocator must check if it is empty or not on its destructor.</dd>
            <dt id="aafba0ee16fbc894407e677c32a51184d">
              <span class="m-doc-wrap-bumper">void <a href="#aafba0ee16fbc894407e677c32a51184d" class="m-doc-self">set_check_empty_on_destructor</a>(</span><span class="m-doc-wrap">bool check_empty_on_destructor)</span>
            </dt>
            <dd>Sets if the allocator must check if it is empty or not on its destructor.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#aeb4c2293314eb40060a95249ca079b65" class="m-doc">alloc</a>(</span><span class="m-doc-wrap"><a href="#a809c23e52711015a49b2f16057769250" class="m-doc">size_<wbr />type</a> bytes) -&gt; void*</span>
            </dt>
            <dd>Allocates uninitialized storage.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a402445b6368cc80817dbc693ffdbd62b" class="m-doc">calloc</a>(</span><span class="m-doc-wrap"><a href="#a809c23e52711015a49b2f16057769250" class="m-doc">size_<wbr />type</a> num,
              <a href="#a809c23e52711015a49b2f16057769250" class="m-doc">size_<wbr />type</a> bytes) -&gt; void*</span>
            </dt>
            <dd>Allocates storage for an array of num objects of bytes size and initializes all bytes in it to zero.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#aa0c96d738a6ff2b0f642b886eda00b2d" class="m-doc">realloc</a>(</span><span class="m-doc-wrap">void* ptr,
              <a href="#a809c23e52711015a49b2f16057769250" class="m-doc">size_<wbr />type</a> new_bytes) -&gt; void*</span>
            </dt>
            <dd>Reallocates the given storage.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a135bd5c9d1c7643b6a87fa2d5f00ef85" class="m-doc">free</a>(</span><span class="m-doc-wrap">void* ptr)</span>
            </dt>
            <dd>Deallocates the storage previously allocated by alloc, calloc or realloc.</dd>
            <dt>
              <div class="m-doc-template">template&lt;typename Type, typename... Args&gt;</div>
              <span class="m-doc-wrap-bumper">auto <a href="#a5a9d25668fbbadcda28b81927ccae71b" class="m-doc">create</a>(</span><span class="m-doc-wrap">Args &amp;&amp; ... args) -&gt; Type&amp;</span>
            </dt>
            <dd>Constructs a value inside of the allocator.</dd>
            <dt id="a1cdfbd52053dd28758d44f705dfe6bbf">
              <div class="m-doc-template">template&lt;typename Type&gt;</div>
              <span class="m-doc-wrap-bumper">void <a href="#a1cdfbd52053dd28758d44f705dfe6bbf" class="m-doc-self">destroy</a>(</span><span class="m-doc-wrap">Type&amp; value)</span>
            </dt>
            <dd>Destroys the given value, previously allocated with the create method.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#af1fc9b06a4cefb4116e5c3d558471952" class="m-doc">reset</a>(</span><span class="m-doc-wrap">void* start,
              <a href="#a809c23e52711015a49b2f16057769250" class="m-doc">size_<wbr />type</a> bytes)</span>
            </dt>
            <dd>Setups the allocator to manage a new chunk of memory.</dd>
            <dt id="a4ff7fae927cebb586c7d2f3a25fead28">
              <span class="m-doc-wrap-bumper">void <a href="#a4ff7fae927cebb586c7d2f3a25fead28" class="m-doc-self">log_status</a>(</span><span class="m-doc-wrap">) const</span>
            </dt>
            <dd>Logs the current status of the allocator.</dd>
          </dl>
        </section>
        <section>
          <h2>Function documentation</h2>
          <section class="m-doc-details" id="ace6e7ccb38e57c0780e58727a28f1e8c"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> bn::<wbr />best_fit_allocator::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ace6e7ccb38e57c0780e58727a28f1e8c" class="m-doc-self">best_fit_allocator</a>(</span><span class="m-doc-wrap">void* start,
              <a href="#a809c23e52711015a49b2f16057769250" class="m-doc">size_<wbr />type</a> bytes)</span></span>
            </h3>
            <p>Constructor.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">start</td>
                  <td>Pointer to the first element of the memory to manage.</td>
                </tr>
                <tr>
                  <td>bytes</td>
                  <td>Size in bytes of the memory to manage.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="ab4e580faa25922fa10e1f1bebcbf9d51"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> bn::<wbr />best_fit_allocator::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ab4e580faa25922fa10e1f1bebcbf9d51" class="m-doc-self">~best_fit_allocator</a>(</span><span class="m-doc-wrap">) <span class="m-label m-success">noexcept</span></span></span>
            </h3>
            <p>Destructor.</p>
<p>It doesn&#x27;t destroy its elements, they must be destroyed manually.</p>
          </div></section>
          <section class="m-doc-details" id="aeb4c2293314eb40060a95249ca079b65"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void* bn::<wbr />best_fit_allocator::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aeb4c2293314eb40060a95249ca079b65" class="m-doc-self">alloc</a>(</span><span class="m-doc-wrap"><a href="#a809c23e52711015a49b2f16057769250" class="m-doc">size_<wbr />type</a> bytes)</span></span>
            </h3>
            <p>Allocates uninitialized storage.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">bytes</td>
                  <td>Bytes to allocate.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>On success, returns the pointer to the beginning of newly allocated memory. On failure, returns <code>nullptr</code>.</td>
                </tr>
              </tfoot>
            </table>
<p>To avoid a memory leak, the returned pointer must be deallocated with free.</p>
          </div></section>
          <section class="m-doc-details" id="a402445b6368cc80817dbc693ffdbd62b"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void* bn::<wbr />best_fit_allocator::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a402445b6368cc80817dbc693ffdbd62b" class="m-doc-self">calloc</a>(</span><span class="m-doc-wrap"><a href="#a809c23e52711015a49b2f16057769250" class="m-doc">size_<wbr />type</a> num,
              <a href="#a809c23e52711015a49b2f16057769250" class="m-doc">size_<wbr />type</a> bytes)</span></span>
            </h3>
            <p>Allocates storage for an array of num objects of bytes size and initializes all bytes in it to zero.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">num</td>
                  <td>Number of objects.</td>
                </tr>
                <tr>
                  <td>bytes</td>
                  <td>Size in bytes of each object.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>On success, returns the pointer to the beginning of newly allocated memory. On failure, returns <code>nullptr</code>.</td>
                </tr>
              </tfoot>
            </table>
<p>To avoid a memory leak, the returned pointer must be deallocated with free.</p>
          </div></section>
          <section class="m-doc-details" id="aa0c96d738a6ff2b0f642b886eda00b2d"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void* bn::<wbr />best_fit_allocator::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aa0c96d738a6ff2b0f642b886eda00b2d" class="m-doc-self">realloc</a>(</span><span class="m-doc-wrap">void* ptr,
              <a href="#a809c23e52711015a49b2f16057769250" class="m-doc">size_<wbr />type</a> new_bytes)</span></span>
            </h3>
            <p>Reallocates the given storage.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">ptr</td>
                  <td>Pointer to the storage to reallocate.</td>
                </tr>
                <tr>
                  <td>new_bytes</td>
                  <td>New size in bytes of the reallocated storage.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>On success, returns the pointer to the beginning of newly allocated storage. On failure, returns <code>nullptr</code>.</td>
                </tr>
              </tfoot>
            </table>
<p>If ptr was not previously allocated by alloc, calloc or realloc, the behavior is undefined.</p><p>On success, the original pointer ptr is invalidated and any access to it is undefined behavior (even if reallocation was in-place).</p><p>To avoid a memory leak, the returned pointer must be deallocated with free.</p>
          </div></section>
          <section class="m-doc-details" id="a135bd5c9d1c7643b6a87fa2d5f00ef85"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />best_fit_allocator::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a135bd5c9d1c7643b6a87fa2d5f00ef85" class="m-doc-self">free</a>(</span><span class="m-doc-wrap">void* ptr)</span></span>
            </h3>
            <p>Deallocates the storage previously allocated by alloc, calloc or realloc.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">ptr</td>
                  <td>Pointer to the storage to deallocate. It is invalidated and any access to it is undefined behavior.</td>
                </tr>
              </tbody>
            </table>
<p>If ptr is <code>nullptr</code>, the function does nothing.</p><p>If ptr was not previously allocated by alloc, calloc or realloc, the behavior is undefined.</p>
          </div></section>
          <section class="m-doc-details" id="a5a9d25668fbbadcda28b81927ccae71b"><div>
            <h3>
              <div class="m-doc-template">
                template&lt;typename Type, typename... Args&gt;
              </div>
              <span class="m-doc-wrap-bumper">Type&amp; bn::<wbr />best_fit_allocator::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a5a9d25668fbbadcda28b81927ccae71b" class="m-doc-self">create</a>(</span><span class="m-doc-wrap">Args &amp;&amp; ... args)</span></span>
            </h3>
            <p>Constructs a value inside of the allocator.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">args</td>
                  <td>Parameters of the value to construct.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to the new value.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="af1fc9b06a4cefb4116e5c3d558471952"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />best_fit_allocator::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af1fc9b06a4cefb4116e5c3d558471952" class="m-doc-self">reset</a>(</span><span class="m-doc-wrap">void* start,
              <a href="#a809c23e52711015a49b2f16057769250" class="m-doc">size_<wbr />type</a> bytes)</span></span>
            </h3>
            <p>Setups the allocator to manage a new chunk of memory.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">start</td>
                  <td>Pointer to the first element of the memory to manage.</td>
                </tr>
                <tr>
                  <td>bytes</td>
                  <td>Size in bytes of the memory to manage.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
<div class="m-doc-search" id="search">
  <a href="#!" onclick="return hideSearch()"></a>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-m-8 m-push-m-2">
        <div class="m-doc-search-header m-text m-small">
          <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
          <div id="search-symbolcount">&hellip;</div>
        </div>
        <div class="m-doc-search-content">
          <form>
            <input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
          </form>
          <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
          <div id="search-help" class="m-text m-dim m-text-center">
            <p class="m-noindent">Search for symbols, directories, files, pages or
            modules. You can omit any prefix from the symbol or file path; adding a
            <code>:</code> or <code>/</code> suffix lists all members of given symbol or
            directory.</p>
            <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span>
            / <span class="m-label m-dim">&uarr;</span> to navigate through the list,
            <span class="m-label m-dim">Enter</span> to go.
            <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
            copy a link to the result using <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">M</span> produces a Markdown link.</p>
          </div>
          <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
          <ul id="search-results"></ul>
        </div>
      </div>
    </div>
  </div>
</div>
<script src="search-v2.js"></script>
<script src="searchdata-v2.js" async="async"></script>
<footer><nav>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <p>Butano Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.14.0 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
      </div>
    </div>
  </div>
</nav></footer>
</body>
</html>
